home *** CD-ROM | disk | FTP | other *** search
/ Workbench Add-On / Workbench Add-On - Volume 1.iso / BBS-Archive / Dev / gcc-2.6.3-bin.lha / GNU / info / gcc.info-10 (.txt) < prev    next >
GNU Info File  |  1995-03-30  |  42KB  |  729 lines

  1. This is Info file gcc.info, produced by Makeinfo-1.55 from the input
  2. file gcc.texi.
  3.    This file documents the use and the internals of the GNU compiler.
  4.    Published by the Free Software Foundation 675 Massachusetts Avenue
  5. Cambridge, MA 02139 USA
  6.    Copyright (C) 1988, 1989, 1992, 1993, 1994 Free Software Foundation,
  7.    Permission is granted to make and distribute verbatim copies of this
  8. manual provided the copyright notice and this permission notice are
  9. preserved on all copies.
  10.    Permission is granted to copy and distribute modified versions of
  11. this manual under the conditions for verbatim copying, provided also
  12. that the sections entitled "GNU General Public License," "Funding for
  13. Free Software," and "Protect Your Freedom--Fight `Look And Feel'" are
  14. included exactly as in the original, and provided that the entire
  15. resulting derived work is distributed under the terms of a permission
  16. notice identical to this one.
  17.    Permission is granted to copy and distribute translations of this
  18. manual into another language, under the above conditions for modified
  19. versions, except that the sections entitled "GNU General Public
  20. License," "Funding for Free Software," and "Protect Your Freedom--Fight
  21. `Look And Feel'", and this permission notice, may be included in
  22. translations approved by the Free Software Foundation instead of in the
  23. original English.
  24. File: gcc.info,  Node: External Bugs,  Next: Incompatibilities,  Prev: Interoperation,  Up: Trouble
  25. Problems Compiling Certain Programs
  26. ===================================
  27.    Certain programs have problems compiling.
  28.    * Parse errors may occur compiling X11 on a Decstation running
  29.      Ultrix 4.2 because of problems in DEC's versions of the X11 header
  30.      files `X11/Xlib.h' and `X11/Xutil.h'.  People recommend adding
  31.      `-I/usr/include/mit' to use the MIT versions of the header files,
  32.      using the `-traditional' switch to turn off ANSI C, or fixing the
  33.      header files by adding this:
  34.           #ifdef __STDC__
  35.           #define NeedFunctionPrototypes 0
  36.           #endif
  37.    * If you have trouble compiling Perl on a SunOS 4 system, it may be
  38.      because Perl specifies `-I/usr/ucbinclude'.  This accesses the
  39.      unfixed header files.  Perl specifies the options
  40.           -traditional -Dvolatile=__volatile__
  41.           -I/usr/include/sun -I/usr/ucbinclude
  42.           -fpcc-struct-return
  43.      most of which are unnecessary with GCC 2.4.5 and newer versions.
  44.      You can make a properly working Perl by setting `ccflags' to
  45.      `-fwritable-strings' (implied by the `-traditional' in the
  46.      original options) and `cppflags' to empty in `config.sh', then
  47.      typing `./doSH; make depend; make'.
  48.    * On various 386 Unix systems derived from System V, including SCO,
  49.      ISC, and ESIX, you may get error messages about running out of
  50.      virtual memory while compiling certain programs.
  51.      You can prevent this problem by linking GNU CC with the GNU malloc
  52.      (which thus replaces the malloc that comes with the system).  GNU
  53.      malloc is available as a separate package, and also in the file
  54.      `src/gmalloc.c' in the GNU Emacs 19 distribution.
  55.      If you have installed GNU malloc as a separate library package,
  56.      use this option when you relink GNU CC:
  57.           MALLOC=/usr/local/lib/libgmalloc.a
  58.      Alternatively, if you have compiled `gmalloc.c' from Emacs 19, copy
  59.      the object file to `gmalloc.o' and use this option when you relink
  60.      GNU CC:
  61.           MALLOC=gmalloc.o
  62. File: gcc.info,  Node: Incompatibilities,  Next: Fixed Headers,  Prev: External Bugs,  Up: Trouble
  63. Incompatibilities of GNU CC
  64. ===========================
  65.    There are several noteworthy incompatibilities between GNU C and most
  66. existing (non-ANSI) versions of C.  The `-traditional' option
  67. eliminates many of these incompatibilities, *but not all*, by telling
  68. GNU C to behave like the other C compilers.
  69.    * GNU CC normally makes string constants read-only.  If several
  70.      identical-looking string constants are used, GNU CC stores only one
  71.      copy of the string.
  72.      One consequence is that you cannot call `mktemp' with a string
  73.      constant argument.  The function `mktemp' always alters the string
  74.      its argument points to.
  75.      Another consequence is that `sscanf' does not work on some systems
  76.      when passed a string constant as its format control string or
  77.      input.  This is because `sscanf' incorrectly tries to write into
  78.      the string constant.  Likewise `fscanf' and `scanf'.
  79.      The best solution to these problems is to change the program to use
  80.      `char'-array variables with initialization strings for these
  81.      purposes instead of string constants.  But if this is not possible,
  82.      you can use the `-fwritable-strings' flag, which directs GNU CC to
  83.      handle string constants the same way most C compilers do.
  84.      `-traditional' also has this effect, among others.
  85.    * `-2147483648' is positive.
  86.      This is because 2147483648 cannot fit in the type `int', so
  87.      (following the ANSI C rules) its data type is `unsigned long int'.
  88.      Negating this value yields 2147483648 again.
  89.    * GNU CC does not substitute macro arguments when they appear inside
  90.      of string constants.  For example, the following macro in GNU CC
  91.           #define foo(a) "a"
  92.      will produce output `"a"' regardless of what the argument A is.
  93.      The `-traditional' option directs GNU CC to handle such cases
  94.      (among others) in the old-fashioned (non-ANSI) fashion.
  95.    * When you use `setjmp' and `longjmp', the only automatic variables
  96.      guaranteed to remain valid are those declared `volatile'.  This is
  97.      a consequence of automatic register allocation.  Consider this
  98.      function:
  99.           jmp_buf j;
  100.           
  101.           foo ()
  102.           {
  103.             int a, b;
  104.           
  105.             a = fun1 ();
  106.             if (setjmp (j))
  107.               return a;
  108.           
  109.             a = fun2 ();
  110.             /* `longjmp (j)' may occur in `fun3'. */
  111.             return a + fun3 ();
  112.           }
  113.      Here `a' may or may not be restored to its first value when the
  114.      `longjmp' occurs.  If `a' is allocated in a register, then its
  115.      first value is restored; otherwise, it keeps the last value stored
  116.      in it.
  117.      If you use the `-W' option with the `-O' option, you will get a
  118.      warning when GNU CC thinks such a problem might be possible.
  119.      The `-traditional' option directs GNU C to put variables in the
  120.      stack by default, rather than in registers, in functions that call
  121.      `setjmp'.  This results in the behavior found in traditional C
  122.      compilers.
  123.    * Programs that use preprocessor directives in the middle of macro
  124.      arguments do not work with GNU CC.  For example, a program like
  125.      this will not work:
  126.           foobar (
  127.           #define luser
  128.                   hack)
  129.      ANSI C does not permit such a construct.  It would make sense to
  130.      support it when `-traditional' is used, but it is too much work to
  131.      implement.
  132.    * Declarations of external variables and functions within a block
  133.      apply only to the block containing the declaration.  In other
  134.      words, they have the same scope as any other declaration in the
  135.      same place.
  136.      In some other C compilers, a `extern' declaration affects all the
  137.      rest of the file even if it happens within a block.
  138.      The `-traditional' option directs GNU C to treat all `extern'
  139.      declarations as global, like traditional compilers.
  140.    * In traditional C, you can combine `long', etc., with a typedef
  141.      name, as shown here:
  142.           typedef int foo;
  143.           typedef long foo bar;
  144.      In ANSI C, this is not allowed: `long' and other type modifiers
  145.      require an explicit `int'.  Because this criterion is expressed by
  146.      Bison grammar rules rather than C code, the `-traditional' flag
  147.      cannot alter it.
  148.    * PCC allows typedef names to be used as function parameters.  The
  149.      difficulty described immediately above applies here too.
  150.    * PCC allows whitespace in the middle of compound assignment
  151.      operators such as `+='.  GNU CC, following the ANSI standard, does
  152.      not allow this.  The difficulty described immediately above
  153.      applies here too.
  154.    * GNU CC complains about unterminated character constants inside of
  155.      preprocessor conditionals that fail.  Some programs have English
  156.      comments enclosed in conditionals that are guaranteed to fail; if
  157.      these comments contain apostrophes, GNU CC will probably report an
  158.      error.  For example, this code would produce an error:
  159.           #if 0
  160.           You can't expect this to work.
  161.           #endif
  162.      The best solution to such a problem is to put the text into an
  163.      actual C comment delimited by `/*...*/'.  However, `-traditional'
  164.      suppresses these error messages.
  165.    * Many user programs contain the declaration `long time ();'.  In the
  166.      past, the system header files on many systems did not actually
  167.      declare `time', so it did not matter what type your program
  168.      declared it to return.  But in systems with ANSI C headers, `time'
  169.      is declared to return `time_t', and if that is not the same as
  170.      `long', then `long time ();' is erroneous.
  171.      The solution is to change your program to use `time_t' as the
  172.      return type of `time'.
  173.    * When compiling functions that return `float', PCC converts it to a
  174.      double.  GNU CC actually returns a `float'.  If you are concerned
  175.      with PCC compatibility, you should declare your functions to return
  176.      `double'; you might as well say what you mean.
  177.    * When compiling functions that return structures or unions, GNU CC
  178.      output code normally uses a method different from that used on most
  179.      versions of Unix.  As a result, code compiled with GNU CC cannot
  180.      call a structure-returning function compiled with PCC, and vice
  181.      versa.
  182.      The method used by GNU CC is as follows: a structure or union
  183.      which is 1, 2, 4 or 8 bytes long is returned like a scalar.  A
  184.      structure or union with any other size is stored into an address
  185.      supplied by the caller (usually in a special, fixed register, but
  186.      on some machines it is passed on the stack).  The
  187.      machine-description macros `STRUCT_VALUE' and
  188.      `STRUCT_INCOMING_VALUE' tell GNU CC where to pass this address.
  189.      By contrast, PCC on most target machines returns structures and
  190.      unions of any size by copying the data into an area of static
  191.      storage, and then returning the address of that storage as if it
  192.      were a pointer value.  The caller must copy the data from that
  193.      memory area to the place where the value is wanted.  GNU CC does
  194.      not use this method because it is slower and nonreentrant.
  195.      On some newer machines, PCC uses a reentrant convention for all
  196.      structure and union returning.  GNU CC on most of these machines
  197.      uses a compatible convention when returning structures and unions
  198.      in memory, but still returns small structures and unions in
  199.      registers.
  200.      You can tell GNU CC to use a compatible convention for all
  201.      structure and union returning with the option
  202.      `-fpcc-struct-return'.
  203.    * GNU C complains about program fragments such as `0x74ae-0x4000'
  204.      which appear to be two hexadecimal constants separated by the minus
  205.      operator.  Actually, this string is a single "preprocessing token".
  206.      Each such token must correspond to one token in C.  Since this
  207.      does not, GNU C prints an error message.  Although it may appear
  208.      obvious that what is meant is an operator and two values, the ANSI
  209.      C standard specifically requires that this be treated as erroneous.
  210.      A "preprocessing token" is a "preprocessing number" if it begins
  211.      with a digit and is followed by letters, underscores, digits,
  212.      periods and `e+', `e-', `E+', or `E-' character sequences.
  213.      To make the above program fragment valid, place whitespace in
  214.      front of the minus sign.  This whitespace will end the
  215.      preprocessing number.
  216. File: gcc.info,  Node: Fixed Headers,  Next: Disappointments,  Prev: Incompatibilities,  Up: Trouble
  217. Fixed Header Files
  218. ==================
  219.    GNU CC needs to install corrected versions of some system header
  220. files.  This is because most target systems have some header files that
  221. won't work with GNU CC unless they are changed.  Some have bugs, some
  222. are incompatible with ANSI C, and some depend on special features of
  223. other compilers.
  224.    Installing GNU CC automatically creates and installs the fixed header
  225. files, by running a program called `fixincludes' (or for certain
  226. targets an alternative such as `fixinc.svr4').  Normally, you don't
  227. need to pay attention to this.  But there are cases where it doesn't do
  228. the right thing automatically.
  229.    * If you update the system's header files, such as by installing a
  230.      new system version, the fixed header files of GNU CC are not
  231.      automatically updated.  The easiest way to update them is to
  232.      reinstall GNU CC.  (If you want to be clever, look in the makefile
  233.      and you can find a shortcut.)
  234.    * On some systems, in particular SunOS 4, header file directories
  235.      contain machine-specific symbolic links in certain places.  This
  236.      makes it possible to share most of the header files among hosts
  237.      running the same version of SunOS 4 on different machine models.
  238.      The programs that fix the header files do not understand this
  239.      special way of using symbolic links; therefore, the directory of
  240.      fixed header files is good only for the machine model used to
  241.      build it.
  242.      In SunOS 4, only programs that look inside the kernel will notice
  243.      the difference between machine models.  Therefore, for most
  244.      purposes, you need not be concerned about this.
  245.      It is possible to make separate sets of fixed header files for the
  246.      different machine models, and arrange a structure of symbolic
  247.      links so as to use the proper set, but you'll have to do this by
  248.      hand.
  249.    * On Lynxos, GNU CC by default does not fix the header files.  This
  250.      is because bugs in the shell cause the `fixincludes' script to
  251.      fail.
  252.      This means you will encounter problems due to bugs in the system
  253.      header files.  It may be no comfort that they aren't GNU CC's
  254.      fault, but it does mean that there's nothing for us to do about
  255.      them.
  256. File: gcc.info,  Node: Disappointments,  Next: C++ Misunderstandings,  Prev: Fixed Headers,  Up: Trouble
  257. Disappointments and Misunderstandings
  258. =====================================
  259.    These problems are perhaps regrettable, but we don't know any
  260. practical way around them.
  261.    * Certain local variables aren't recognized by debuggers when you
  262.      compile with optimization.
  263.      This occurs because sometimes GNU CC optimizes the variable out of
  264.      existence.  There is no way to tell the debugger how to compute the
  265.      value such a variable "would have had", and it is not clear that
  266.      would be desirable anyway.  So GNU CC simply does not mention the
  267.      eliminated variable when it writes debugging information.
  268.      You have to expect a certain amount of disagreement between the
  269.      executable and your source code, when you use optimization.
  270.    * Users often think it is a bug when GNU CC reports an error for code
  271.      like this:
  272.           int foo (struct mumble *);
  273.           
  274.           struct mumble { ... };
  275.           
  276.           int foo (struct mumble *x)
  277.           { ... }
  278.      This code really is erroneous, because the scope of `struct
  279.      mumble' in the prototype is limited to the argument list
  280.      containing it.  It does not refer to the `struct mumble' defined
  281.      with file scope immediately below--they are two unrelated types
  282.      with similar names in different scopes.
  283.      But in the definition of `foo', the file-scope type is used
  284.      because that is available to be inherited.  Thus, the definition
  285.      and the prototype do not match, and you get an error.
  286.      This behavior may seem silly, but it's what the ANSI standard
  287.      specifies.  It is easy enough for you to make your code work by
  288.      moving the definition of `struct mumble' above the prototype.
  289.      It's not worth being incompatible with ANSI C just to avoid an
  290.      error for the example shown above.
  291.    * Accesses to bitfields even in volatile objects works by accessing
  292.      larger objects, such as a byte or a word.  You cannot rely on what
  293.      size of object is accessed in order to read or write the bitfield;
  294.      it may even vary for a given bitfield according to the precise
  295.      usage.
  296.      If you care about controlling the amount of memory that is
  297.      accessed, use volatile but do not use bitfields.
  298.    * GNU CC comes with shell scripts to fix certain known problems in
  299.      system header files.  They install corrected copies of various
  300.      header files in a special directory where only GNU CC will
  301.      normally look for them.  The scripts adapt to various systems by
  302.      searching all the system header files for the problem cases that
  303.      we know about.
  304.      If new system header files are installed, nothing automatically
  305.      arranges to update the corrected header files.  You will have to
  306.      reinstall GNU CC to fix the new header files.  More specifically,
  307.      go to the build directory and delete the files `stmp-fixinc' and
  308.      `stmp-headers', and the subdirectory `include'; then do `make
  309.      install' again.
  310.    * On 68000 systems, you can get paradoxical results if you test the
  311.      precise values of floating point numbers.  For example, you can
  312.      find that a floating point value which is not a NaN is not equal
  313.      to itself.  This results from the fact that the the floating point
  314.      registers hold a few more bits of precision than fit in a `double'
  315.      in memory.  Compiled code moves values between memory and floating
  316.      point registers at its convenience, and moving them into memory
  317.      truncates them.
  318.      You can partially avoid this problem by using the `-ffloat-store'
  319.      option (*note Optimize Options::.).
  320.    * On the MIPS, variable argument functions using `varargs.h' cannot
  321.      have a floating point value for the first argument.  The reason
  322.      for this is that in the absence of a prototype in scope, if the
  323.      first argument is a floating point, it is passed in a floating
  324.      point register, rather than an integer register.
  325.      If the code is rewritten to use the ANSI standard `stdarg.h'
  326.      method of variable arguments, and the prototype is in scope at the
  327.      time of the call, everything will work fine.
  328. File: gcc.info,  Node: C++ Misunderstandings,  Next: Protoize Caveats,  Prev: Disappointments,  Up: Trouble
  329. Common Misunderstandings with GNU C++
  330. =====================================
  331.    C++ is a complex language and an evolving one, and its standard
  332. definition (the ANSI C++ draft standard) is also evolving.  As a result,
  333. your C++ compiler may occasionally surprise you, even when its behavior
  334. is correct.  This section discusses some areas that frequently give
  335. rise to questions of this sort.
  336. * Menu:
  337. * Static Definitions::  Static member declarations are not definitions
  338. * Temporaries::         Temporaries may vanish before you expect
  339. File: gcc.info,  Node: Static Definitions,  Next: Temporaries,  Up: C++ Misunderstandings
  340. Declare *and* Define Static Members
  341. -----------------------------------
  342.    When a class has static data members, it is not enough to *declare*
  343. the static member; you must also *define* it.  For example:
  344.      class Foo
  345.      {
  346.        ...
  347.        void method();
  348.        static int bar;
  349.      };
  350.    This declaration only establishes that the class `Foo' has an `int'
  351. named `Foo::bar', and a member function named `Foo::method'.  But you
  352. still need to define *both* `method' and `bar' elsewhere.  According to
  353. the draft ANSI standard, you must supply an initializer in one (and
  354. only one) source file, such as:
  355.      int Foo::bar = 0;
  356.    Other C++ compilers may not correctly implement the standard
  357. behavior.  As a result, when you switch to `g++' from one of these
  358. compilers, you may discover that a program that appeared to work
  359. correctly in fact does not conform to the standard: `g++' reports as
  360. undefined symbols any static data members that lack definitions.
  361. File: gcc.info,  Node: Temporaries,  Prev: Static Definitions,  Up: C++ Misunderstandings
  362. Temporaries May Vanish Before You Expect
  363. ----------------------------------------
  364.    It is dangerous to use pointers or references to *portions* of a
  365. temporary object.  The compiler may very well delete the object before
  366. you expect it to, leaving a pointer to garbage.  The most common place
  367. where this problem crops up is in classes like the libg++ `String'
  368. class, that define a conversion function to type `char *' or `const
  369. char *'.  However, any class that returns a pointer to some internal
  370. structure is potentially subject to this problem.
  371.    For example, a program may use a function `strfunc' that returns
  372. `String' objects, and another function `charfunc' that operates on
  373. pointers to `char':
  374.      String strfunc ();
  375.      void charfunc (const char *);
  376. In this situation, it may seem natural to write
  377. `charfunc (strfunc ());' based on the knowledge that class `String' has
  378. an explicit conversion to `char' pointers.  However, what really
  379. happens is akin to `charfunc (strfunc ().convert ());', where the
  380. `convert' method is a function to do the same data conversion normally
  381. performed by a cast.  Since the last use of the temporary `String'
  382. object is the call to the conversion function, the compiler may delete
  383. that object before actually calling `charfunc'.  The compiler has no
  384. way of knowing that deleting the `String' object will invalidate the
  385. pointer.  The pointer then points to garbage, so that by the time
  386. `charfunc' is called, it gets an invalid argument.
  387.    Code like this may run successfully under some other compilers,
  388. especially those that delete temporaries relatively late.  However, the
  389. GNU C++ behavior is also standard-conformant, so if your program depends
  390. on late destruction of temporaries it is not portable.
  391.    If you think this is surprising, you should be aware that the ANSI
  392. C++ committee continues to debate the lifetime-of-temporaries problem.
  393.    For now, at least, the safe way to write such code is to give the
  394. temporary a name, which forces it to remain until the end of the scope
  395. of the name.  For example:
  396.      String& tmp = strfunc ();
  397.      charfunc (tmp);
  398. File: gcc.info,  Node: Protoize Caveats,  Next: Non-bugs,  Prev: C++ Misunderstandings,  Up: Trouble
  399. Caveats of using `protoize'
  400. ===========================
  401.    The conversion programs `protoize' and `unprotoize' can sometimes
  402. change a source file in a way that won't work unless you rearrange it.
  403.    * `protoize' can insert references to a type name or type tag before
  404.      the definition, or in a file where they are not defined.
  405.      If this happens, compiler error messages should show you where the
  406.      new references are, so fixing the file by hand is straightforward.
  407.    * There are some C constructs which `protoize' cannot figure out.
  408.      For example, it can't determine argument types for declaring a
  409.      pointer-to-function variable; this you must do by hand.  `protoize'
  410.      inserts a comment containing `???' each time it finds such a
  411.      variable; so you can find all such variables by searching for this
  412.      string.  ANSI C does not require declaring the argument types of
  413.      pointer-to-function types.
  414.    * Using `unprotoize' can easily introduce bugs.  If the program
  415.      relied on prototypes to bring about conversion of arguments, these
  416.      conversions will not take place in the program without prototypes.
  417.      One case in which you can be sure `unprotoize' is safe is when you
  418.      are removing prototypes that were made with `protoize'; if the
  419.      program worked before without any prototypes, it will work again
  420.      without them.
  421.      You can find all the places where this problem might occur by
  422.      compiling the program with the `-Wconversion' option.  It prints a
  423.      warning whenever an argument is converted.
  424.    * Both conversion programs can be confused if there are macro calls
  425.      in and around the text to be converted.  In other words, the
  426.      standard syntax for a declaration or definition must not result
  427.      from expanding a macro.  This problem is inherent in the design of
  428.      C and cannot be fixed.  If only a few functions have confusing
  429.      macro calls, you can easily convert them manually.
  430.    * `protoize' cannot get the argument types for a function whose
  431.      definition was not actually compiled due to preprocessor
  432.      conditionals.  When this happens, `protoize' changes nothing in
  433.      regard to such a function.  `protoize' tries to detect such
  434.      instances and warn about them.
  435.      You can generally work around this problem by using `protoize' step
  436.      by step, each time specifying a different set of `-D' options for
  437.      compilation, until all of the functions have been converted.
  438.      There is no automatic way to verify that you have got them all,
  439.      however.
  440.    * Confusion may result if there is an occasion to convert a function
  441.      declaration or definition in a region of source code where there
  442.      is more than one formal parameter list present.  Thus, attempts to
  443.      convert code containing multiple (conditionally compiled) versions
  444.      of a single function header (in the same vicinity) may not produce
  445.      the desired (or expected) results.
  446.      If you plan on converting source files which contain such code, it
  447.      is recommended that you first make sure that each conditionally
  448.      compiled region of source code which contains an alternative
  449.      function header also contains at least one additional follower
  450.      token (past the final right parenthesis of the function header).
  451.      This should circumvent the problem.
  452.    * `unprotoize' can become confused when trying to convert a function
  453.      definition or declaration which contains a declaration for a
  454.      pointer-to-function formal argument which has the same name as the
  455.      function being defined or declared.  We recommand you avoid such
  456.      choices of formal parameter names.
  457.    * You might also want to correct some of the indentation by hand and
  458.      break long lines.  (The conversion programs don't write lines
  459.      longer than eighty characters in any case.)
  460. File: gcc.info,  Node: Non-bugs,  Next: Warnings and Errors,  Prev: Protoize Caveats,  Up: Trouble
  461. Certain Changes We Don't Want to Make
  462. =====================================
  463.    This section lists changes that people frequently request, but which
  464. we do not make because we think GNU CC is better without them.
  465.    * Checking the number and type of arguments to a function which has
  466.      an old-fashioned definition and no prototype.
  467.      Such a feature would work only occasionally--only for calls that
  468.      appear in the same file as the called function, following the
  469.      definition.  The only way to check all calls reliably is to add a
  470.      prototype for the function.  But adding a prototype eliminates the
  471.      motivation for this feature.  So the feature is not worthwhile.
  472.    * Warning about using an expression whose type is signed as a shift
  473.      count.
  474.      Shift count operands are probably signed more often than unsigned.
  475.      Warning about this would cause far more annoyance than good.
  476.    * Warning about assigning a signed value to an unsigned variable.
  477.      Such assignments must be very common; warning about them would
  478.      cause more annoyance than good.
  479.    * Warning about unreachable code.
  480.      It's very common to have unreachable code in machine-generated
  481.      programs.  For example, this happens normally in some files of GNU
  482.      C itself.
  483.    * Warning when a non-void function value is ignored.
  484.      Coming as I do from a Lisp background, I balk at the idea that
  485.      there is something dangerous about discarding a value.  There are
  486.      functions that return values which some callers may find useful;
  487.      it makes no sense to clutter the program with a cast to `void'
  488.      whenever the value isn't useful.
  489.    * Assuming (for optimization) that the address of an external symbol
  490.      is never zero.
  491.      This assumption is false on certain systems when `#pragma weak' is
  492.      used.
  493.    * Making `-fshort-enums' the default.
  494.      This would cause storage layout to be incompatible with most other
  495.      C compilers.  And it doesn't seem very important, given that you
  496.      can get the same result in other ways.  The case where it matters
  497.      most is when the enumeration-valued object is inside a structure,
  498.      and in that case you can specify a field width explicitly.
  499.    * Making bitfields unsigned by default on particular machines where
  500.      "the ABI standard" says to do so.
  501.      The ANSI C standard leaves it up to the implementation whether a
  502.      bitfield declared plain `int' is signed or not.  This in effect
  503.      creates two alternative dialects of C.
  504.      The GNU C compiler supports both dialects; you can specify the
  505.      signed dialect with `-fsigned-bitfields' and the unsigned dialect
  506.      with `-funsigned-bitfields'.  However, this leaves open the
  507.      question of which dialect to use by default.
  508.      Currently, the preferred dialect makes plain bitfields signed,
  509.      because this is simplest.  Since `int' is the same as `signed int'
  510.      in every other context, it is cleanest for them to be the same in
  511.      bitfields as well.
  512.      Some computer manufacturers have published Application Binary
  513.      Interface standards which specify that plain bitfields should be
  514.      unsigned.  It is a mistake, however, to say anything about this
  515.      issue in an ABI.  This is because the handling of plain bitfields
  516.      distinguishes two dialects of C.  Both dialects are meaningful on
  517.      every type of machine.  Whether a particular object file was
  518.      compiled using signed bitfields or unsigned is of no concern to
  519.      other object files, even if they access the same bitfields in the
  520.      same data structures.
  521.      A given program is written in one or the other of these two
  522.      dialects.  The program stands a chance to work on most any machine
  523.      if it is compiled with the proper dialect.  It is unlikely to work
  524.      at all if compiled with the wrong dialect.
  525.      Many users appreciate the GNU C compiler because it provides an
  526.      environment that is uniform across machines.  These users would be
  527.      inconvenienced if the compiler treated plain bitfields differently
  528.      on certain machines.
  529.      Occasionally users write programs intended only for a particular
  530.      machine type.  On these occasions, the users would benefit if the
  531.      GNU C compiler were to support by default the same dialect as the
  532.      other compilers on that machine.  But such applications are rare.
  533.      And users writing a program to run on more than one type of
  534.      machine cannot possibly benefit from this kind of compatibility.
  535.      This is why GNU CC does and will treat plain bitfields in the same
  536.      fashion on all types of machines (by default).
  537.      There are some arguments for making bitfields unsigned by default
  538.      on all machines.  If, for example, this becomes a universal de
  539.      facto standard, it would make sense for GNU CC to go along with
  540.      it.  This is something to be considered in the future.
  541.      (Of course, users strongly concerned about portability should
  542.      indicate explicitly in each bitfield whether it is signed or not.
  543.      In this way, they write programs which have the same meaning in
  544.      both C dialects.)
  545.    * Undefining `__STDC__' when `-ansi' is not used.
  546.      Currently, GNU CC defines `__STDC__' as long as you don't use
  547.      `-traditional'.  This provides good results in practice.
  548.      Programmers normally use conditionals on `__STDC__' to ask whether
  549.      it is safe to use certain features of ANSI C, such as function
  550.      prototypes or ANSI token concatenation.  Since plain `gcc' supports
  551.      all the features of ANSI C, the correct answer to these questions
  552.      is "yes".
  553.      Some users try to use `__STDC__' to check for the availability of
  554.      certain library facilities.  This is actually incorrect usage in
  555.      an ANSI C program, because the ANSI C standard says that a
  556.      conforming freestanding implementation should define `__STDC__'
  557.      even though it does not have the library facilities.  `gcc -ansi
  558.      -pedantic' is a conforming freestanding implementation, and it is
  559.      therefore required to define `__STDC__', even though it does not
  560.      come with an ANSI C library.
  561.      Sometimes people say that defining `__STDC__' in a compiler that
  562.      does not completely conform to the ANSI C standard somehow
  563.      violates the standard.  This is illogical.  The standard is a
  564.      standard for compilers that claim to support ANSI C, such as `gcc
  565.      -ansi'--not for other compilers such as plain `gcc'.  Whatever the
  566.      ANSI C standard says is relevant to the design of plain `gcc'
  567.      without `-ansi' only for pragmatic reasons, not as a requirement.
  568.    * Undefining `__STDC__' in C++.
  569.      Programs written to compile with C++-to-C translators get the
  570.      value of `__STDC__' that goes with the C compiler that is
  571.      subsequently used.  These programs must test `__STDC__' to
  572.      determine what kind of C preprocessor that compiler uses: whether
  573.      they should concatenate tokens in the ANSI C fashion or in the
  574.      traditional fashion.
  575.      These programs work properly with GNU C++ if `__STDC__' is defined.
  576.      They would not work otherwise.
  577.      In addition, many header files are written to provide prototypes
  578.      in ANSI C but not in traditional C.  Many of these header files
  579.      can work without change in C++ provided `__STDC__' is defined.  If
  580.      `__STDC__' is not defined, they will all fail, and will all need
  581.      to be changed to test explicitly for C++ as well.
  582.    * Deleting "empty" loops.
  583.      GNU CC does not delete "empty" loops because the most likely reason
  584.      you would put one in a program is to have a delay.  Deleting them
  585.      will not make real programs run any faster, so it would be
  586.      pointless.
  587.      It would be different if optimization of a nonempty loop could
  588.      produce an empty one.  But this generally can't happen.
  589.    * Making side effects happen in the same order as in some other
  590.      compiler.
  591.      It is never safe to depend on the order of evaluation of side
  592.      effects.  For example, a function call like this may very well
  593.      behave differently from one compiler to another:
  594.           void func (int, int);
  595.           
  596.           int i = 2;
  597.           func (i++, i++);
  598.      There is no guarantee (in either the C or the C++ standard language
  599.      definitions) that the increments will be evaluated in any
  600.      particular order.  Either increment might happen first.  `func'
  601.      might get the arguments `3, 4', or it might get `4, 3', or even
  602.      `3, 3'.
  603.    * Not allowing structures with volatile fields in registers.
  604.      Strictly speaking, there is no prohibition in the ANSI C standard
  605.      against allowing structures with volatile fields in registers, but
  606.      it does not seem to make any sense and is probably not what you
  607.      wanted to do.  So the compiler will give an error message in this
  608.      case.
  609. File: gcc.info,  Node: Warnings and Errors,  Prev: Non-bugs,  Up: Trouble
  610. Warning Messages and Error Messages
  611. ===================================
  612.    The GNU compiler can produce two kinds of diagnostics: errors and
  613. warnings.  Each kind has a different purpose:
  614.      *Errors* report problems that make it impossible to compile your
  615.      program.  GNU CC reports errors with the source file name and line
  616.      number where the problem is apparent.
  617.      *Warnings* report other unusual conditions in your code that *may*
  618.      indicate a problem, although compilation can (and does) proceed.
  619.      Warning messages also report the source file name and line number,
  620.      but include the text `warning:' to distinguish them from error
  621.      messages.
  622.    Warnings may indicate danger points where you should check to make
  623. sure that your program really does what you intend; or the use of
  624. obsolete features; or the use of nonstandard features of GNU C or C++.
  625. Many warnings are issued only if you ask for them, with one of the `-W'
  626. options (for instance, `-Wall' requests a variety of useful warnings).
  627.    GNU CC always tries to compile your program if possible; it never
  628. gratuituously rejects a program whose meaning is clear merely because
  629. (for instance) it fails to conform to a standard.  In some cases,
  630. however, the C and C++ standards specify that certain extensions are
  631. forbidden, and a diagnostic *must* be issued by a conforming compiler.
  632. The `-pedantic' option tells GNU CC to issue warnings in such cases;
  633. `-pedantic-errors' says to make them errors instead.  This does not
  634. mean that *all* non-ANSI constructs get warnings or errors.
  635.    *Note Options to Request or Suppress Warnings: Warning Options, for
  636. more detail on these and related command-line options.
  637. File: gcc.info,  Node: Bugs,  Next: Service,  Prev: Trouble,  Up: Top
  638. Reporting Bugs
  639. **************
  640.    Your bug reports play an essential role in making GNU CC reliable.
  641.    When you encounter a problem, the first thing to do is to see if it
  642. is already known.  *Note Trouble::.  If it isn't known, then you should
  643. report the problem.
  644.    Reporting a bug may help you by bringing a solution to your problem,
  645. or it may not.  (If it does not, look in the service directory; see
  646. *Note Service::.)  In any case, the principal function of a bug report
  647. is to help the entire community by making the next version of GNU CC
  648. work better.  Bug reports are your contribution to the maintenance of
  649. GNU CC.
  650.    Since the maintainers are very overloaded, we cannot respond to every
  651. bug report.  However, if the bug has not been fixed, we are likely to
  652. send you a patch and ask you to tell us whether it works.
  653.    In order for a bug report to serve its purpose, you must include the
  654. information that makes for fixing the bug.
  655. * Menu:
  656. * Criteria:  Bug Criteria.   Have you really found a bug?
  657. * Where: Bug Lists.         Where to send your bug report.
  658. * Reporting: Bug Reporting.  How to report a bug effectively.
  659. * Patches: Sending Patches.  How to send a patch for GNU CC.
  660. * Known: Trouble.            Known problems.
  661. * Help: Service.             Where to ask for help.
  662. File: gcc.info,  Node: Bug Criteria,  Next: Bug Lists,  Up: Bugs
  663. Have You Found a Bug?
  664. =====================
  665.    If you are not sure whether you have found a bug, here are some
  666. guidelines:
  667.    * If the compiler gets a fatal signal, for any input whatever, that
  668.      is a compiler bug.  Reliable compilers never crash.
  669.    * If the compiler produces invalid assembly code, for any input
  670.      whatever (except an `asm' statement), that is a compiler bug,
  671.      unless the compiler reports errors (not just warnings) which would
  672.      ordinarily prevent the assembler from being run.
  673.    * If the compiler produces valid assembly code that does not
  674.      correctly execute the input source code, that is a compiler bug.
  675.      However, you must double-check to make sure, because you may have
  676.      run into an incompatibility between GNU C and traditional C (*note
  677.      Incompatibilities::.).  These incompatibilities might be considered
  678.      bugs, but they are inescapable consequences of valuable features.
  679.      Or you may have a program whose behavior is undefined, which
  680.      happened by chance to give the desired results with another C or
  681.      C++ compiler.
  682.      For example, in many nonoptimizing compilers, you can write `x;'
  683.      at the end of a function instead of `return x;', with the same
  684.      results.  But the value of the function is undefined if `return'
  685.      is omitted; it is not a bug when GNU CC produces different results.
  686.      Problems often result from expressions with two increment
  687.      operators, as in `f (*p++, *p++)'.  Your previous compiler might
  688.      have interpreted that expression the way you intended; GNU CC might
  689.      interpret it another way.  Neither compiler is wrong.  The bug is
  690.      in your code.
  691.      After you have localized the error to a single source line, it
  692.      should be easy to check for these things.  If your program is
  693.      correct and well defined, you have found a compiler bug.
  694.    * If the compiler produces an error message for valid input, that is
  695.      a compiler bug.
  696.    * If the compiler does not produce an error message for invalid
  697.      input, that is a compiler bug.  However, you should note that your
  698.      idea of "invalid input" might be my idea of "an extension" or
  699.      "support for traditional practice".
  700.    * If you are an experienced user of C or C++ compilers, your
  701.      suggestions for improvement of GNU CC or GNU C++ are welcome in
  702.      any case.
  703. File: gcc.info,  Node: Bug Lists,  Next: Bug Reporting,  Prev: Bug Criteria,  Up: Bugs
  704. Where to Report Bugs
  705. ====================
  706.    Send bug reports for GNU C to `bug-gcc@prep.ai.mit.edu'.
  707.    Send bug reports for GNU C++ to `bug-g++@prep.ai.mit.edu'.  If your
  708. bug involves the C++ class library libg++, send mail to
  709. `bug-lib-g++@prep.ai.mit.edu'.  If you're not sure, you can send the
  710. bug report to both lists.
  711.    *Do not send bug reports to `help-gcc@prep.ai.mit.edu' or to the
  712. newsgroup `gnu.gcc.help'.* Most users of GNU CC do not want to receive
  713. bug reports.  Those that do, have asked to be on `bug-gcc' and/or
  714. `bug-g++'.
  715.    The mailing lists `bug-gcc' and `bug-g++' both have newsgroups which
  716. serve as repeaters: `gnu.gcc.bug' and `gnu.g++.bug'.  Each mailing list
  717. and its newsgroup carry exactly the same messages.
  718.    Often people think of posting bug reports to the newsgroup instead of
  719. mailing them.  This appears to work, but it has one problem which can be
  720. crucial: a newsgroup posting does not contain a mail path back to the
  721. sender.  Thus, if maintainers need more information, they may be unable
  722. to reach you.  For this reason, you should always send bug reports by
  723. mail to the proper mailing list.
  724.    As a last resort, send bug reports on paper to:
  725.      GNU Compiler Bugs
  726.      Free Software Foundation
  727.      675 Mass Ave
  728.      Cambridge, MA 02139
  729.